chore: add api docs in mkdocs build #3715
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
This PR adds a new
mkdocs-typedoc
plugin to our docs so that when runningmkdocs serve
(local dev) ormkdocs build
(CI) it builds the API reference using TypeDoc in addition to the main docs.This will simplify the CI setup (I updated the workflow) but most importantly it also improves the authoring experience which now requires a single command to run everything.
As part of the PR, I also moved the API reference link in the main header, so it's more prominent.
Finally, I have tweaked the
mkdocs.yml
configuration so that whenever we update any (andmkdocs serve
is running), it'll trigger an automatic reload - this was not the case for snippets and API reference before.Issue number: closes #3714
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.